home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 21 / Cream of the Crop 21 (Terry Blount) (October 1996).iso / editor / t2p16.zip / TEXT2PCX.DOC < prev    next >
Text File  |  1996-06-30  |  10KB  |  238 lines
  1.  
  2.                       ------------------------------
  3.                       |                            |
  4.                       |   TEXT2PCX   Version 1.6   |
  5.                       |   by Po Wing   June 1996   |
  6.                       |                            |
  7.                       ------------------------------
  8.  
  9.  
  10.  
  11. CONTENTS
  12.  
  13.   1. License Agreement
  14.   2. Disclaimer
  15.   3. File List
  16.   4. What Is TEXT2PCX?
  17.   5. Using TEXT2PCX
  18.   6. Editing Font Files
  19.   7. Program Limitations
  20.   8. Contacting The Author
  21.  
  22. --------------------------------------------------------------------------------
  23. 1. LICENCE AGREEMENT
  24.  
  25.    TEXT2PCX is Freeware. You may freely use or distribute it, but subject to
  26. the following conditions:
  27.  
  28.  - You may not charge a fee for using or distributing TEXT2PCX, except to
  29.    cover the cost of media, copying or transportation.
  30.  - All the files in the original distribution package are distributed
  31.    together, and in their original, unmodified form. You may repack the
  32.    archive if you wish, as long as you include all the files.
  33.  
  34. --------------------------------------------------------------------------------
  35. 2. DISCLAIMER
  36.  
  37.    Possession and use of TEXT2PCX is entirely at your own risk. The author
  38.  will not be held responsible for any damage or loss incurred as a result
  39.  of the use, misuse or inability to use the software. TEXT2PCX has been
  40.  carefully tested, with no strange behaviour reported. No deliberately
  41.  destructive code has been used.
  42.  
  43. --------------------------------------------------------------------------------
  44. 3. FILE LIST
  45.  
  46.    The following files should be included in the distribution package. If
  47.  any are missing, please report the problem to the administrator of the
  48.  system from which you obtained it, and obtain a new copy from a more
  49.  reliable source.
  50.  
  51.    FILE_ID.DIZ    => Archive description
  52.    FNT8X8.FON     => Font file(text type), size 8x8
  53.    FNT7X15.FNT    => Font file(binary type), size 7x15
  54.    FNT8X15.FNT    => Font file(binary type), size 8x15
  55.    FNT8X16.FNT    => Font file(binary type), size 8x16
  56.    FNT12X24.FNT   => Font file(binary type), size 12x24
  57.    FNTEDIT.EXE    => Font editor for *.FNT files
  58.    README.TXT     => Brief information
  59.    TEXT2PCX.DOC   => This detailed documentation
  60.    TEXT2PCX.EXE   => TEXT2PCX main program
  61.  
  62. --------------------------------------------------------------------------------
  63. 4. WHAT IS TEXT2PCX?
  64.  
  65.    TEXT2PCX is a converion program for transforming a plain text file into
  66. black and white Zsoft PaintBrush (PCX) image file. A user will supply a plain
  67. text file with various options on how the plain text file is read by TEXT2PCX.
  68. The user can control the size of text to be read, or let the program to detect
  69. the size of text, or even produce multiple image outputs.
  70.  
  71.    The program will use the input text to look up a table, a font table. It
  72. will scale automatically to generate an image with specified size. The user
  73. can also control the size or orientation of output image.
  74.  
  75. --------------------------------------------------------------------------------
  76. 5. USING TEXT2PCX
  77.  
  78.    The syntax for the command TEXT2PCX.EXE is as follows:
  79.  
  80.       TEXT2PCX [ option ] input_text_file output_PCX_file
  81.  
  82.    where "input_text_file" is the plain text file,
  83.          "output_PCX_file" will be the output PCX image file
  84.  
  85.  
  86.    The options are listed below:
  87.  
  88.   -TC col ---> to control the number of column, "col", of text to be read by
  89.                each page. The default value is 80.
  90.      e.g. TEXT2PCX -TC 100 input.txt output.pcx
  91.  
  92.   -TR row ---> to control the number of row, "row", of text to be read by each
  93.                page. The default value is 25.
  94.      e.g. TEXT2PCX -TR 30 input.txt output.pcx
  95.  
  96.   -AT     ---> this will try to automatically calculate the maximum column and
  97.                row of input text, but the size of input text should not be
  98.                VERY LARGE.
  99.      e.g. TEXT2PCX -AT input.txt output.pcx
  100.  
  101.   -PW wid ---> to control the width, "wid", of output image in number of pixels.
  102.                This value input will be automatically converted to nearest
  103.                integer divisible by 8. The default is 640 pixels.
  104.      e.g. TEXT2PCX -PW 720 input.txt output.pcx
  105.  
  106.   -PL len ---> to control the length, "len", of output image in number of
  107.                pixels. The default is 200 pixels.
  108.      e.g. TEXT2PCX -PL 400 input.txt output.pcx
  109.  
  110.   -MW wid ---> supply the width, "wid", of image and will automatically find
  111.                the length of image which maintaining the aspect ratio based on
  112.                input text.
  113.      e.g. TEXT2PCX -MW 720 input.txt output.pcx
  114.  
  115.   -ML len ---> supply the length, "len", of image and will automatically find
  116.                the width of image which maintaining the aspect ratio based on
  117.                input text. IGNORED if -MW is also specified.
  118.      e.g. TEXT2PCX -ML 400 input.txt output.pcx
  119.  
  120.   -HR res ---> image horizontal resolution in dpi, default=200
  121.      e.g. TEXT2PCX -HR 360 input.txt output.pcx
  122.  
  123.   -VR res ---> image vertical resolution in dpi, default=200
  124.      e.g. TEXT2PCX -VR 360 input.txt output.pcx
  125.  
  126.   -R      ---> rotate text by 90 degree anti-clockwisely which produce an
  127.                image in landscape orientation.
  128.      e.g. TEXT2PCX -R input.txt output.pcx
  129.  
  130.   -I      ---> inverse output, i.e. black <-> white
  131.      e.g. TEXT2PCX -I input.txt output.pcx
  132.  
  133.   -MF     ---> create multiple PCX image files. No file extension is required
  134.                since the extension will be automatically added. For output file,
  135.                outfile, image output files will be outfile.nnn (nnn=000 to 999).
  136.                Text is broken into multiple text for each image, where breaks
  137.                are determined by the size of text specified.
  138.      e.g. TEXT2PCX -MF input.txt output
  139.  
  140.   -ME     ---> similar to -MF but text are broken at at form feed character,
  141.                0x0c.
  142.      e.g. TEXT2PCX -ME input.txt output
  143.  
  144.   -B file ---> use customized font file in binary format: file contains first
  145.                2 bytes specifying width and height of each character, followed
  146.                by 256 blocks of data where block size=ceil(width/8)Xheight.
  147.                Use FNTEDIT.EXE to edit the font file.
  148.      e.g. TEXT2PCX -B fnt8x15.fnt input.txt output.pcx
  149.  
  150.   -V file ---> use customized font file in visual format: each entry contains
  151.                ASCII code of character followed by 8X8 bit-map of 0 and 1.
  152.                This will override -B option.
  153.      e.g. TEXT2PCX -V fnt8x8.fon input.txt output.pcx
  154.  
  155.   -SC num ---> Skip last page if last page contains less than "num" of
  156.                characters. This is useful when last page of multiple pages have
  157.                only several printer control codes.
  158.      e.g. TEXT2PCX -SC 5 input.txt output.pcx
  159.  
  160.   -S      ---> suppress display of statistics at the end of conversion.
  161.      e.g. TEXT2PCX -S input.txt output.pcx
  162.  
  163.  
  164.  
  165.    Several options can be combined to use at the same time. The common examples
  166. are as follows:
  167.  
  168.      e.g. TEXT2PCX -ME -R -B fnt12x24.fnt -SC 3 -S input.txt output
  169.      e.g. TEXT2PCX -TC 132 -TR 50 -MW 1000 input.txt output.pcx
  170.      e.g. TEXT2PCX -AT -ML 1000 input.txt output.pcx
  171.      e.g. TEXT2PCX -TC 132 -MF -R -V fnt8x8.fon -S input.txt output
  172.  
  173. --------------------------------------------------------------------------------
  174. 6. EDITING FONT FILES
  175.  
  176.    There are two types of font files to be used by TEXT2PCX.EXE, text type and
  177. binary type.
  178.  
  179.    The text type is the font file that you can use your favourite text editor
  180. to edit. The FNT8X8.FON is the example included in this archive.
  181.  
  182.    The format is simple as shown below. It consists of a line specifying the
  183. ASCII code of the character and a 8X8 bitmap of the character. There is no need
  184. to include all 256 characters, only those you want to customize.
  185.  
  186. 1
  187. 01111110
  188. 10000001
  189. 10100101
  190. 10000001
  191. 10111101
  192. 10011001
  193. 10000001
  194. 01111110
  195. 65
  196. 00110000
  197. 01001000
  198. 10000100
  199. 10000100
  200. 11111100
  201. 10000100
  202. 10000100
  203. 00000000
  204.  
  205.  
  206.    The binary type is font files in binary format and